gridpack::factory::BaseFactory< _network > Class Template Reference

#include <base_factory.hpp>

Collaboration diagram for gridpack::factory::BaseFactory< _network >:

[legend]

List of all members.

Public Types
typedef _network	NetworkType
typedef boost::shared_ptr < NetworkType >	NetworkPtr
Public Member Functions
	BaseFactory (NetworkPtr network)
virtual	~BaseFactory (void)
virtual void	setComponents (void)
virtual void	load (void)
virtual void	setExchange (bool flag=true)
virtual void	setMode (int mode)
virtual void	setBusMode (int mode)
virtual void	setBranchMode (int mode)
bool	checkTrue (bool flag)
bool	checkTrueSomewhere (bool flag)
void	saveData (void)
void	getBusPointers (gridpack::component::BaseBusComponent ***buses, int *nbus)
void	getBranchPointers (gridpack::component::BaseBranchComponent ***branches, int *nbranch)
void	dumpData (void)

template<class _network>
class gridpack::factory::BaseFactory< _network >

---

Member Typedef Documentation

template<class _network>

typedef boost::shared_ptr<NetworkType> gridpack::factory::BaseFactory< _network >::NetworkPtr

template<class _network>

typedef _network gridpack::factory::BaseFactory< _network >::NetworkType

---

Constructor & Destructor Documentation

template<class _network>

gridpack::factory::BaseFactory< _network >::BaseFactory

(

NetworkPtr

network

)

Constructor

Parameters:

network

network that factory operates on

template<class _network>

virtual gridpack::factory::BaseFactory< _network >::~BaseFactory

(

void

)

[virtual]

Destructor

---

Member Function Documentation

template<class _network>

bool gridpack::factory::BaseFactory< _network >::checkTrue

(

bool

flag

)

A convenience function that checks to see if something is true on all processors

Parameters:

flag

boolean flag on each processor

Returns:

true if flag is true on all processors, false otherwise

template<class _network>

bool gridpack::factory::BaseFactory< _network >::checkTrueSomewhere

(

bool

flag

)

A convenience function that checks to see if something is true on at least one processor

Parameters:

flag

boolean flag on each processor

Returns:

true if flag is true on at least one processor, false otherwise

template<class _network>

void gridpack::factory::BaseFactory< _network >::dumpData

(

void

)

Debugging call that will dump contents of DataCollection objects on each bus and branch. This call will attempt to guarantee that output is generated sequentially from each processor but this will probably fail because of IO buffering

template<class _network>

void gridpack::factory::BaseFactory< _network >::getBranchPointers	(	gridpack::component::BaseBranchComponent ***	branches,
		int *	nbranch
	)

return a pointer to the branch list

Parameters:

	branches	pointer to a list of base branch component pointers
	nbranch	number of branches on processor

template<class _network>

void gridpack::factory::BaseFactory< _network >::getBusPointers	(	gridpack::component::BaseBusComponent ***	buses,
		int *	nbus
	)

return a pointer to the bus list

Parameters:

	buses	pointer to a list of base bus component pointers
	nbus	number of buses on processor

template<class _network>

virtual void gridpack::factory::BaseFactory< _network >::load

(

void

)

[virtual]

Generic method that invokes the "load" method on all branches and buses to move data from the DataCollection objects on the network into the corresponding buses and branches

template<class _network>

void gridpack::factory::BaseFactory< _network >::saveData

(

void

)

Save internal state variables of the buses and branches to the associated data collection object for possible use in output or to transfer them to another network

template<class _network>

virtual void gridpack::factory::BaseFactory< _network >::setBranchMode

(

int

mode

)

[virtual]

Set the mode for all BaseBranchComponent objects in the network.

Parameters:

mode

integer representing desired mode

template<class _network>

virtual void gridpack::factory::BaseFactory< _network >::setBusMode

(

int

mode

)

[virtual]

Set the mode for all BaseBusComponent objects in the network.

Parameters:

mode

integer representing desired mode

template<class _network>

virtual void gridpack::factory::BaseFactory< _network >::setComponents

(

void

)

[virtual]

Set pointers in each bus and branch component so that it points to connected buses and branches. This routine operates on the generic BaseBusComponent and BaseBranchComponent interfaces. It also sets some indices in MatVecInterface for each component.

template<class _network>

virtual void gridpack::factory::BaseFactory< _network >::setExchange

(

bool

flag = true

)

[virtual]

Set up the exchange buffers so that they work correctly. This should only be called after the network topology has been specified

Parameters:

flag

if true then have network allocate buffers for exchange, otherwise use external buffers

template<class _network>

virtual void gridpack::factory::BaseFactory< _network >::setMode

(

int

mode

)

[virtual]

Set the mode for all BaseComponent objects in the network.

Parameters:

mode

integer representing desired mode

---

The documentation for this class was generated from the following file:

• base_factory.hpp